Enviar Documentos para Analises
Para a melhor performance da validação automática em relação a qualidade de imagem do documento/selfie, os parâmetros de tamanho da imagem devem seguir os requisistos:
- tamanho mínimo: 100KB
- tamanho máximo: 4.5MB
- extensões: JPEG, PNG, PDF
Requisição
POST [Url Ambiente]/Analises/Enviar
Header
| Identificador | Valor |
|---|---|
| Content-type | application/json |
| Accept | application/json |
| Authorization | Bearer [Valor do Token retornado na Autenticação] |
Body
| Parâmetro | Descrição | Tipo | Exemplos | Obrigatório |
|---|---|---|---|---|
| Chave | Campo para identificação da analise | String | "ChaveDefinidaPeloCliente" | Sim |
| ImagemFrente | Imagem da frente do documento | Base64 | Base64 | Sim |
| ImagemVerso | Imagem do verso do documento | Base64 | Base64 | Não |
| TelefoneCelular | Número do Telefone | String | "11999999999" | Não |
| Valor | Valor da proposta | String | "R$0,00" | Não |
| EnderecoCep | CEP do endereço | String | "00000-000" | Não |
| EnderecoLogradouro | Logradouro do endereço | String | "Rua Exemplo" | Não |
| EnderecoNumero | Numero do endereço | String | "16" | Não |
| EnderecoComplemento | Complemento do endereço | String | "Casa 2" | Não |
| EnderecoBairro | Bairro do endereço | String | "Bairro" | Não |
| EnderecoCidade | Cidade do endereço | String | "Cidade Exemplo" | Não |
| EnderecoUf | UF do endereço | String | "SP" | Não |
| ImagemSelfie | Imagem da selfie | Base64 | Base64 | Não |
| ImagemQrCode | Imagem do QrCode para documentos digitais | Base64 | Base64 | Não |
| CPF | CPF para validação em bases cadastrais | String | "000000000000" | Não |
| NomeInformado | Nome informado para validação em bases cadastrais | String | "NomeExemplo" | Não |
| NomeMãeInformado | Nome da Mãe informado para validação em bases cadastrais | String | "NomeExemplo" | Não |
| DataNascimentoInformada | Data de Nascimento para validação em bases cadastrais | String | "01/01/0001" | Não |
| NumeroDocumentoInformado | Numero de Documento para validação em bases cadastrais | String | "00.000.000-0" | Não |
| WebHook | Configurações para envio de webhook especificas da analise | Objeto | { "Url": "https://meuwebhook.com.br/api/receber", "Headers": { "token" : "sf8sd9f89ds7f9dsf9ds79f7ds" } } | Não |
| Url | Endereço de envio do resultado da analise | String | "https://meuwebhook.com.br/api/receber" | Não |
| Headers | Configurações de cabeçalhos para envio de webhook especificas da analise | Objeto | { "token" : "sf8sd9f89ds7f9dsf9ds79f7ds", "Content-Type" : "application/json" } | Não |
| Opcoes | Configurações de opções adicionais | Objeto | { "RequerMesa": "sim", "MensagemParaAnalista": "Documento Requer Mesa" } | Não |
| RequerMesa | Configuração de obrigatoriedade para documento ser analisado pela mesa ("sim" habilita a opção) | String | "sim" | Não |
| MensagemParaAnalista | Mensagem que irá aparecer na tela do analista caso a opção Requer Mesa for acionada | String | "Mensagem de Exemplo" | Não |
Exemplo
{
"Chave": "string",
"ImagemFrente": "string",
"ImagemVerso": "string",
"TelefoneCelular": "string",
"Valor": "string",
"EnderecoCep": "string",
"EnderecoLogradouro": "string",
"EnderecoNumero": "string",
"EnderecoComplemento": "string",
"EnderecoBairro": "string",
"EnderecoCidade": "string",
"EnderecoUf": "string",
"ImagemSelfie": "string",
"ImagemQrCode": "string",
"CPF": "string",
"NumeroDocumentoInformado": "00.000.000-00",
"NomeInformado": "NomeExemplo",
"NomeMaeInformado": "NomeExemplo",
"DataNascimentoInformada": "02/01/1984",
"WebHook": {
"Url": "https://meuwebhook.com.br/api/receber",
"Headers": {
"Content-Type": "application/json",
"token": "sf8sd9f89ds7f9dsf9ds79f7ds"
}
},
"Opcoes": {
"RequerMesa": "sim",
"MensagemParaAnalista": "string"
}
}
Status Code 200
Retorno de sucesso.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Status | Status da requisição | OK = 0, ERRO = 1 | 0 |
| Mensagens | Descrição dos erros | String[] | ["SUCESSO"] |
Exemplo
{
"Status": 0,
"Mensagens": [
"SUCESSO"
]
}
Status Code 401
Usuário/Senha inválidos.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Status | Status da requisição | OK = 0, ERRO = 1 | 1 |
| Mensagens | Descrição dos erros | String[] | "Mensagens": [] |
Status Code 404
Erro 404 - Url não encontrado
O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.
Status Code 500
Erro não tratado pelo sistema.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| Status | Status da requisição | OK/ERRO | ERRO |
| Mensagens | Descrição dos erros | String[] | "Mensagens": [] |
Exemplo
{
"Status": "ERRO",
"Mensagens": [
"string"
]
}